←Select platform

SaveTemplateFile(String,Int32[],SaveCapabilityOptions) Method

Summary

Saves a list of capabilities to the specified template file on disk.

Syntax

C++

public void SaveTemplateFile(  
   string templateFileName, 
   int[] capabilities, 
   Leadtools.Twain.SaveCapabilityOptions options 
)

Public Overloads Sub SaveTemplateFile( _ 
   ByVal templateFileName As String, _ 
   ByVal capabilities() As Integer, _ 
   ByVal options As Leadtools.Twain.SaveCapabilityOptions _ 
)

public: 
void SaveTemplateFile(  
   String^ templateFileName, 
   array<int>^ capabilities, 
   Leadtools.Twain.SaveCapabilityOptions options 
)

Parameters

templateFileName
The name of the file in which to save the capabilities of the selected TWAIN source.

capabilities
Array of capabilities to be saved. Cannot be null and must contain at least one capability.

options
Options that specify which values to save. For more information, refer to SaveCapabilityOptions.

Remarks

For each capability provided by the capabilities parameter, an SaveTemplate event occurs. For more information, refer to Handling Template Files.

Example

Imports Leadtools 
Imports Leadtools.Twain 
 
Public Sub SaveTemplateFileExample(ByVal parent As IntPtr) 
   Dim session As TwainSession = New TwainSession() 
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None) 
 
   ' Set TwainCapabilityType.ImageTransferMechanism capability 
   Dim cap As TwainCapability = New TwainCapability() 
   cap.Information.ContainerType = Leadtools.Twain.TwainContainerType.OneValue 
   cap.Information.Type = Leadtools.Twain.TwainCapabilityType.ImageTransferMechanism 
   cap.OneValueCapability.ItemType = Leadtools.Twain.TwainItemType.Uint16 
   cap.OneValueCapability.Value = CShort(Leadtools.Twain.TwainCapabilityValue.TransferMechanismNative) 
   session.SetCapability(cap, TwainSetCapabilityMode.Set) 
 
   ' Set TwainCapabilityType.ImageUnits capability 
   cap.Information.Type = Leadtools.Twain.TwainCapabilityType.ImageUnits 
   cap.OneValueCapability.Value = CShort(Leadtools.Twain.TwainCapabilityValue.UnitCentimeters) 
   session.SetCapability(cap, TwainSetCapabilityMode.Set) 
 
   session.SaveTemplateFile(Path.Combine(LEAD_VARS.ImagesDir, "Out_test.ltt")) 
 
   session.Shutdown() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

using Leadtools; 
using Leadtools.Twain; 
 
public void SaveTemplateFileExample(IntPtr parent) 
{ 
   TwainSession session = new TwainSession(); 
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None); 
   // Set TwainCapabilityType.ImageTransferMechanism capability 
   TwainCapability cap = new TwainCapability(); 
   cap.Information.ContainerType = Leadtools.Twain.TwainContainerType.OneValue; 
   cap.Information.Type = TwainCapabilityType.ImageTransferMechanism; 
   cap.OneValueCapability.ItemType = Leadtools.Twain.TwainItemType.Uint16; 
   cap.OneValueCapability.Value = (short)Leadtools.Twain.TwainCapabilityValue.TransferMechanismNative; 
   session.SetCapability(cap, TwainSetCapabilityMode.Set); 
 
   // Set TwainCapabilityType.ImageUnits capability 
   cap.Information.Type = TwainCapabilityType.ImageUnits; 
   cap.OneValueCapability.Value = (short)Leadtools.Twain.TwainCapabilityValue.UnitCentimeters; 
   session.SetCapability(cap, TwainSetCapabilityMode.Set); 
 
   // Save both above set capabilities to template file on disk. 
   int[] capabilities = { (int)TwainCapabilityType.ImageTransferMechanism, (int)TwainCapabilityType.ImageUnits }; 
   session.SaveTemplateFile(Path.Combine(LEAD_VARS.ImagesDir, "test.ltt"), capabilities, SaveCapabilityOptions.Current); 
 
   session.Shutdown(); 
} 
 
static class LEAD_VARS 
{ 
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}